/*
 * TMap Designer - A Thematic Map design software
 * Copyright (C) 2006 World Health Organization
 * http://www.who.int
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package who.tmap.bo;

import java.util.List;
import java.util.Map;

/**
 * @author stl
 *
 * TODO To change the template for this generated type comment go to
 * Window - Preferences - Java - Code Style - Code Templates
 */
public interface Attrs extends BizObject {

    /**
     * Header is an ordered collection of AttrDef
     * @param header
     */
    void setHeader( List<AttrDef> header );
    List<AttrDef> getHeader();
    
    /**
     * Rows is an ordered collection of Map ( key is the row index )
     * containing ordered collection of Object ( key is the field index )
     */
    @SuppressWarnings("unchecked")
	List<List> getRows();
	@SuppressWarnings("unchecked")
	void setRows( List<List> rows );
	
	/**
	 * Can be used to store the index of the join id
	 * in the attributes collection
	 * @param joinIdIdx
	 */
	void setJoinIdIdx( int joinIdIdx );
	int getJoinIdIdx();
	
	/**
	 * Can be used to store the index of the data
	 * in the attributes collection
	 * @param dataIdx
	 */
	void setDataIdx( int dataIdx );
	int getDataIdx();
	
	/**
	 * Can be used to store the index of x column 
	 * (for entering coordinates in the point cd)
	 * in the attributes collection
	 * @param xColumnIdx
	 */	
	void setXColumnIdx( int xColumnIdx );
	int getXColumnIdx();
	
	/**
	 * Can be used to store the index of y column 
	 * (for entering coordinates in the point cd)
	 * in the attributes collection
	 * @param yColumnIdx
	 */	
	void setYColumnIdx( int yColumnIdx );
	int getYColumnIdx();	
	
	/**
	 * Can be used to store the index of descriptor column 
	 * (for entering coordinates description in the point cd)
	 * in the attributes collection
	 * @param yColumnIdx
	 */		
	void setDescriptorColumnIdx( int descriptorColumnIdx );
	int getDescriptorColumnIdx();
	
	/**
	 * Can be used to store the index of size column 
	 * in the attributes collection
	 * @param yColumnIdx
	 */		
	void setSizeColumnIdx( int sizeColumnIdx );
	int getSizeColumnIdx();	
	
	/**
	 * Data Source properties for TMap Designer 
	 * "Reload from data source" function
	 * @param dsProperties
	 */
	void setDsProperties( Map<String, String> dsProperties );
	Map<String, String> getDsProperties();
}
